

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Working with group data &mdash; Apache Usergrid 2.x documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="Apache Usergrid 2.x documentation" href="../index.html"/>
        <link rel="next" title="Activity" href="activity.html"/>
        <link rel="prev" title="Working with User Data" href="working-user-data.html"/> 

  
  <script src="../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-nav-search">
        

        
          <a href="../index.html" class="icon icon-home"> Apache Usergrid
        

        
        </a>

        
          
          
            <div class="version">
              2.x
            </div>
          
        

        
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

        
      </div>

      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
        
          
          
              <p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../introduction/overview.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li>
</ul>
<p class="caption"><span class="caption-text">Using Usergrid</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../using-usergrid/creating-account.html">Creating a Usergrid Account</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using-usergrid/creating-a-new-application.html">Creating a new application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using-usergrid/using-a-sandbox-app.html">Using a Sandbox Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using-usergrid/using-the-api.html">Using the API</a></li>
</ul>
<p class="caption"><span class="caption-text">Data Storage</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li>
</ul>
<p class="caption"><span class="caption-text">Data Queries</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters &amp; clauses</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators &amp; data types</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li>
</ul>
<p class="caption"><span class="caption-text">Entity Connections</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li>
<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li>
</ul>
<p class="caption"><span class="caption-text">Push Notifications</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/overview.html">Push notifications overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/adding-push-support.html">Adding push notifications support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/getting-started.html">Getting started with push notifications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/tutorial.html">Tutorial: Push notifications sample app</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/registering.html">Registering with a notification service</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/creating-notifiers.html">Creating notifiers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/managing-users-and-devices.html">Managing users and devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/creating-and-managing-notifications.html">Creating and managing notifications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../push-notifications/troubleshooting.html">Troubleshooting</a></li>
</ul>
<p class="caption"><span class="caption-text">Security &amp; Authentication</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security &amp; token authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-roles.html">Using roles</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users &amp; app clients</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li>
</ul>
<p class="caption"><span class="caption-text">User Management &amp; Social Graph</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="user-management.html">User management &amp; social graph</a></li>
<li class="toctree-l1"><a class="reference internal" href="working-user-data.html">Working with User Data</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Working with group data</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#creating-groups">Creating groups</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#request-syntax">Request Syntax</a></li>
<li class="toctree-l3"><a class="reference internal" href="#request-uri">Request URI</a></li>
<li class="toctree-l3"><a class="reference internal" href="#example">Example</a></li>
<li class="toctree-l3"><a class="reference internal" href="#request">Request</a></li>
<li class="toctree-l3"><a class="reference internal" href="#response">Response</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#retrieving-groups">Retrieving groups</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id1">Request Syntax</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id2">Request URI</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#parameter-description">Parameter Description</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id3">Request</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id4">Response</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#retrieving-a-group-s-users">Retrieving a group&#8217;s users</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id5">Request URI</a></li>
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a></li>
<li class="toctree-l3"><a class="reference internal" href="#example-request">Example - Request</a></li>
<li class="toctree-l3"><a class="reference internal" href="#example-response">Example - Response</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#deleting-a-group">Deleting a group</a></li>
<li class="toctree-l2"><a class="reference internal" href="#adding-a-user-to-a-group">Adding a user to a group</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id6">Request syntax</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id7">Request URI</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id8">Example</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id9">Request</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id10">Response</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#removing-a-user-from-a-group">Removing a user from a group</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id11">Request syntax</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id12">Example request</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id13">Example response</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="activity.html">Activity</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-connections.html">Social Graph Connections</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-connections.html#creating-other-connections">Creating other connections</a></li>
<li class="toctree-l1"><a class="reference internal" href="messagee-example.html">App Example - Messagee</a></li>
</ul>
<p class="caption"><span class="caption-text">Geo-location</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li>
</ul>
<p class="caption"><span class="caption-text">Assets &amp; Files</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/uploading-assets.html">Uploading assets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/retrieving-assets.html">Retrieving assets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../assets-and-files/folders.html">Folders</a></li>
</ul>
<p class="caption"><span class="caption-text">Counters &amp; Events</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters &amp; events</a></li>
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating &amp; incrementing counters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li>
<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li>
</ul>
<p class="caption"><span class="caption-text">Organizations &amp; Applications</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization &amp; application management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li>
<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/admin-user.html">Admin user</a></li>
</ul>
<p class="caption"><span class="caption-text">API Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#sub-types">Sub-Types</a></li>
</ul>
<p class="caption"><span class="caption-text">Client SDKs</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li>
</ul>
<p class="caption"><span class="caption-text">Installing Usergrid</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation/deployment-guide.html">Usergrid 2.1.0 Deployment Guide</a></li>
</ul>
<p class="caption"><span class="caption-text">More about Usergrid</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations &amp; Videos</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code &amp; Docs</a></li>
</ul>

          
        
      </div>
      &nbsp;
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
        <a href="../index.html">Apache Usergrid</a>
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="breadcrumbs navigation">
  <ul class="wy-breadcrumbs">
    <li><a href="../index.html">Docs</a> &raquo;</li>
      
    <li>Working with group data</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../_sources/user-management/group.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="working-with-group-data">
<h1>Working with group data<a class="headerlink" href="#working-with-group-data" title="Permalink to this headline">¶</a></h1>
<p>You can organize app users into groups. Groups have their own Activity
Feed, their own permissions and be a useful alternative to Roles,
depending on how you model your data. Groups were originally designed to
emulate Facebook Groups, so they will tend to function about the same
way Facebook Groups would.</p>
<p>Groups are hierarchical. Every member of the group
<code class="docutils literal"><span class="pre">/groups/california/san-francisco</span></code> is also a member of the group
<code class="docutils literal"><span class="pre">/groups/california</span></code>.</p>
<p>Groups are also a great way to model things such a topic subscriptions.
For example, you could allow people to subscribe (i.e. become a member
of the group and be alerted via Activities) to
<code class="docutils literal"><span class="pre">/groups/memes/dogs/doge</span></code> or subscribe to all <code class="docutils literal"><span class="pre">/groups/memes/dogs</span></code>.</p>
<p>See the <a class="reference external" href="../rest-endpoints/api-docs.html#group">Group Model section of the API
Reference</a> for a list of the
system-defined properties for group entities. In addition, you can
create group properties specific to your application.</p>
<div class="section" id="creating-groups">
<h2>Creating groups<a class="headerlink" href="#creating-groups" title="Permalink to this headline">¶</a></h2>
<p>A group entity represents an application group of users. You can create,
retrieve, update, delete, and query group entities. See <a class="reference external" href="../rest-endpoints/api-doc.html#user">User entity
properties</a> for a list of the
system-defined properties for group entities. In addition, you can
create group properties specific to your application.</p>
<div class="section" id="request-syntax">
<h3>Request Syntax<a class="headerlink" href="#request-syntax" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>curl -X POST &quot;https://api.usergrid.com/your-org/your-app/groups&quot; &#39;{ request body }&#39;
</pre></div>
</div>
<p>Use the POST method to create a new group. Groups use paths to indicate
their unique names. This allows you to create group hierarchies by using
slashes. For this reason, you need to specify a path property for a new
group.</p>
</div>
<div class="section" id="request-uri">
<h3>Request URI<a class="headerlink" href="#request-uri" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre><span class="n">POST</span> <span class="o">/</span><span class="p">{</span><span class="n">org_id</span><span class="p">}</span><span class="o">/</span><span class="p">{</span><span class="n">app_id</span><span class="p">}</span><span class="o">/</span><span class="n">groups</span>
</pre></div>
</div>
<p>Parameters</p>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
<col width="78%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>uuid | org_id</td>
<td>Organization UUID or organization name</td>
</tr>
<tr class="row-odd"><td>uuid | app_id</td>
<td>Application UUID or application name</td>
</tr>
<tr class="row-even"><td>request body</td>
<td>One or more sets of group properties of which path is mandatory.</td>
</tr>
</tbody>
</table>
<p>The <code class="docutils literal"><span class="pre">path</span></code> property is required and must be unique, it may include
forward slashes to denote hierarchical relationships.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
    <span class="s">&quot;path&quot;</span> <span class="p">:</span> <span class="s">&quot;somegroup/somesubgroup&quot;</span><span class="p">,</span>
    <span class="s">&quot;title&quot;</span> <span class="p">:</span> <span class="s">&quot;Some SubGroup&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="example">
<h3>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
<p><strong>Note</strong>: Although not shown in the API examples below, you need to
provide a valid access token with each API call. See <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating
users and application
clients</a>
for details.</p>
</div>
<div class="section" id="request">
<h3>Request<a class="headerlink" href="#request" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>curl -X POST &quot;https://api.usergrid.com/my-org/my-app/groups&quot; -d &#39;{&quot;path&quot;:&quot;mynewgroup&quot;}&#39;
</pre></div>
</div>
</div>
<div class="section" id="response">
<h3>Response<a class="headerlink" href="#response" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
    <span class="s">&quot;action&quot;</span><span class="p">:</span> <span class="s">&quot;post&quot;</span><span class="p">,</span>
    <span class="s">&quot;application&quot;</span><span class="p">:</span> <span class="s">&quot;7fb8d891-477d-11e1-b2bd-22000a1c4e22&quot;</span><span class="p">,</span>
    <span class="s">&quot;params&quot;</span><span class="p">:</span> <span class="p">{},</span>
    <span class="s">&quot;path&quot;</span><span class="p">:</span> <span class="s">&quot;/groups&quot;</span><span class="p">,</span>
    <span class="s">&quot;uri&quot;</span><span class="p">:</span> <span class="s">&quot;https://api.usergrid.com/22000a1c4e22-7fb8d891-477d-11e1-b2bd/7fb8d891-477d-11e1-b2bd-22000a1c4e22/groups&quot;</span><span class="p">,</span>
    <span class="s">&quot;entities&quot;</span><span class="p">:</span> <span class="p">[{</span>
        <span class="s">&quot;uuid&quot;</span><span class="p">:</span> <span class="s">&quot;a668717b-67cb-11e1-8223-12313d14bde7&quot;</span><span class="p">,</span>
        <span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;group&quot;</span><span class="p">,</span>
        <span class="s">&quot;created&quot;</span><span class="p">:</span> <span class="mi">1331066016571</span><span class="p">,</span>
        <span class="s">&quot;modified&quot;</span><span class="p">:</span> <span class="mi">1331066016571</span><span class="p">,</span>
        <span class="s">&quot;metadata&quot;</span><span class="p">:</span> <span class="p">{</span>
            <span class="s">&quot;path&quot;</span><span class="p">:</span> <span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7&quot;</span><span class="p">,</span>
            <span class="s">&quot;sets&quot;</span><span class="p">:</span> <span class="p">{</span>
                <span class="s">&quot;rolenames&quot;</span><span class="p">:</span> <span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/rolenames&quot;</span><span class="p">,</span>
                <span class="s">&quot;permissions&quot;</span><span class="p">:</span> <span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/permissions&quot;</span>
            <span class="p">},</span>
            <span class="s">&quot;collections&quot;</span><span class="p">:</span> <span class="p">{</span>
                <span class="s">&quot;activities&quot;</span><span class="p">:</span> <span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/activities&quot;</span><span class="p">,</span>
                <span class="s">&quot;feed&quot;</span><span class="p">:</span> <span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/feed&quot;</span><span class="p">,</span>
                <span class="s">&quot;roles&quot;</span><span class="p">:</span> <span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/roles&quot;</span><span class="p">,</span>
                <span class="s">&quot;users&quot;</span><span class="p">:</span> <span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/users&quot;</span>
            <span class="p">}</span>
        <span class="p">},</span>
        <span class="s">&quot;path&quot;</span><span class="p">:</span> <span class="s">&quot;mynewgroup&quot;</span>
    <span class="p">}],</span>
    <span class="s">&quot;timestamp&quot;</span><span class="p">:</span> <span class="mi">1331066016563</span><span class="p">,</span>
    <span class="s">&quot;duration&quot;</span><span class="p">:</span> <span class="mi">35</span><span class="p">,</span>
    <span class="s">&quot;organization&quot;</span><span class="p">:</span> <span class="s">&quot;my-org&quot;</span><span class="p">,</span>
    <span class="s">&quot;applicationName&quot;</span><span class="p">:</span> <span class="s">&quot;my-app&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="retrieving-groups">
<h2>Retrieving groups<a class="headerlink" href="#retrieving-groups" title="Permalink to this headline">¶</a></h2>
<p>Retrieving group data</p>
<p>You can retrieve data about groups through cURL or one of the SDKs. Each
provides a way to filter the list of groups by data associated with the
group, such as title or path, or other properties in the group entity.</p>
<p>See the <a class="reference external" href="../rest-endpoints/api-docs.html#group">Group Model section of the API
Reference</a> for a list of the
system-defined properties for group entities. In addition, you can
create group properties specific to your application.</p>
<div class="section" id="id1">
<h3>Request Syntax<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>curl -X GET &quot;https://api.usergrid.com/my-org/my-app/groups/mynewgroup&quot;
</pre></div>
</div>
<p>Use the GET method to retrieve group data.</p>
</div>
<div class="section" id="id2">
<h3>Request URI<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>GET /&lt;org_id | uuid&gt;/&lt;app_id | uuid&gt;/groups&lt;/groupPath | uuid&gt; | &lt;?ql=query_string&gt;
</pre></div>
</div>
<p>Parameters</p>
</div>
</div>
<div class="section" id="parameter-description">
<h2>Parameter Description<a class="headerlink" href="#parameter-description" title="Permalink to this headline">¶</a></h2>
<p>org_id | uuid Organization UUID or organization name app_id | uuid
Application UUID or application name groupPath | uuid Group UUID or
group path, which must be unique. query_string A data store query. For
more on queries, see <a class="reference external" href="../data-queries/querying-your-data.html">Data
queries</a>.</p>
<div class="section" id="id3">
<h3>Request<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre># Get a group by the group path, &quot;employees/managers&quot;.
curl -X GET &quot;https://api.usergrid.com/my-org/my-app/groups/employees/managers&quot;

# Get a group by UUID.
curl -X GET &quot;https://api.usergrid.com/my-org/my-app/groups/a407b1e7-58e8-11e1-ac46-22000a1c5a67e&quot;

# Get group data filtering by their title.
curl -X GET &quot;https://api.usergrid.com/my-org/my-app/groups?ql=select%20*%20where%20title%3D&#39;Management%20Employees&#39;&quot;
</pre></div>
</div>
</div>
<div class="section" id="id4">
<h3>Response<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
<p>The following is an example of JSON returned by a query for a single
group.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
    <span class="s">&quot;action&quot;</span> <span class="p">:</span> <span class="s">&quot;get&quot;</span><span class="p">,</span>
    <span class="s">&quot;application&quot;</span> <span class="p">:</span> <span class="s">&quot;db1e60a0-417f-11e3-9586-0f1ff3650d20&quot;</span><span class="p">,</span>
    <span class="s">&quot;params&quot;</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
    <span class="s">&quot;path&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups&quot;</span><span class="p">,</span>
    <span class="s">&quot;uri&quot;</span> <span class="p">:</span> <span class="s">&quot;https://api.usergrid.com/steventraut/mynewapp/groups&quot;</span><span class="p">,</span>
    <span class="s">&quot;entities&quot;</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
        <span class="s">&quot;uuid&quot;</span> <span class="p">:</span> <span class="s">&quot;5005a0fa-6916-11e3-9c1b-b77ec8addc0d&quot;</span><span class="p">,</span>
        <span class="s">&quot;type&quot;</span> <span class="p">:</span> <span class="s">&quot;group&quot;</span><span class="p">,</span>
        <span class="s">&quot;created&quot;</span> <span class="p">:</span> <span class="mi">1387503030399</span><span class="p">,</span>
        <span class="s">&quot;modified&quot;</span> <span class="p">:</span> <span class="mi">1387503030399</span><span class="p">,</span>
        <span class="s">&quot;path&quot;</span> <span class="p">:</span> <span class="s">&quot;managers&quot;</span><span class="p">,</span>
        <span class="s">&quot;metadata&quot;</span> <span class="p">:</span> <span class="p">{</span>
            <span class="s">&quot;path&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/5005a0fa-6916-11e3-9c1b-b77ec8addc0d&quot;</span><span class="p">,</span>
            <span class="s">&quot;sets&quot;</span> <span class="p">:</span> <span class="p">{</span>
                <span class="s">&quot;rolenames&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/5005a0fa-6916-11e3-9c1b-b77ec8addc0d/roles&quot;</span><span class="p">,</span>
                <span class="s">&quot;permissions&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/5005a0fa-6916-11e3-9c1b-b77ec8addc0d/permissions&quot;</span>
            <span class="p">},</span>
            <span class="s">&quot;collections&quot;</span> <span class="p">:</span> <span class="p">{</span>
                <span class="s">&quot;activities&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/5005a0fa-6916-11e3-9c1b-b77ec8addc0d/activities&quot;</span><span class="p">,</span>
                <span class="s">&quot;feed&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/5005a0fa-6916-11e3-9c1b-b77ec8addc0d/feed&quot;</span><span class="p">,</span>
                <span class="s">&quot;roles&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/5005a0fa-6916-11e3-9c1b-b77ec8addc0d/roles&quot;</span><span class="p">,</span>
                <span class="s">&quot;users&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/5005a0fa-6916-11e3-9c1b-b77ec8addc0d/users&quot;</span>
            <span class="p">}</span>
        <span class="p">},</span>
        <span class="s">&quot;title&quot;</span> <span class="p">:</span> <span class="s">&quot;Management Employees&quot;</span>
    <span class="p">}</span> <span class="p">],</span>
    <span class="s">&quot;timestamp&quot;</span> <span class="p">:</span> <span class="mi">1391020491701</span><span class="p">,</span>
    <span class="s">&quot;duration&quot;</span> <span class="p">:</span> <span class="mi">15</span><span class="p">,</span>
    <span class="s">&quot;organization&quot;</span> <span class="p">:</span> <span class="s">&quot;my-org&quot;</span><span class="p">,</span>
    <span class="s">&quot;applicationName&quot;</span> <span class="p">:</span> <span class="s">&quot;my-app&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="retrieving-a-group-s-users">
<h2>Retrieving a group&#8217;s users<a class="headerlink" href="#retrieving-a-group-s-users" title="Permalink to this headline">¶</a></h2>
<p>Use the GET method to retrieve all the users in a group.</p>
<div class="section" id="id5">
<h3>Request URI<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span><span class="p">{</span><span class="n">org_id</span><span class="p">}</span><span class="o">/</span><span class="p">{</span><span class="n">app_id</span><span class="p">}</span><span class="o">/</span><span class="n">groups</span><span class="o">/</span><span class="p">{</span><span class="n">uuid</span><span class="o">|</span><span class="n">groupname</span><span class="p">}</span><span class="o">/</span><span class="n">users</span>
</pre></div>
</div>
</div>
<div class="section" id="parameters">
<h3>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="42%" />
<col width="58%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>arg uuid|string org_id</td>
<td>Organization UUID or organization name</td>
</tr>
<tr class="row-odd"><td>arg uuid|string app_id</td>
<td>Application UUID or application name</td>
</tr>
<tr class="row-even"><td>arg uuid|string groupname</td>
<td>UUID or name of the group</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="example-request">
<h3>Example - Request<a class="headerlink" href="#example-request" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>curl -X GET &quot;https://api.usergrid.com/my-org/my-app/groups/mygroup/users&quot;
</pre></div>
</div>
</div>
<div class="section" id="example-response">
<h3>Example - Response<a class="headerlink" href="#example-response" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
  <span class="s">&quot;action&quot;</span> <span class="p">:</span> <span class="s">&quot;get&quot;</span><span class="p">,</span>
  <span class="s">&quot;application&quot;</span> <span class="p">:</span> <span class="s">&quot;e7127751-6985-11e2-8078-02e81aeb2129&quot;</span><span class="p">,</span>
  <span class="s">&quot;params&quot;</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
  <span class="s">&quot;path&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/d20976ff-802f-11e2-b690-02e81ae66238/users&quot;</span><span class="p">,</span>
  <span class="s">&quot;uri&quot;</span> <span class="p">:</span> <span class="s">&quot;http://api.usergrid.com/myorg/sandbox/groups/d20976ff-802f-11e2-b690-02e81ae61238/users&quot;</span><span class="p">,</span>
  <span class="s">&quot;entities&quot;</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
    <span class="s">&quot;uuid&quot;</span> <span class="p">:</span> <span class="s">&quot;cd789b00-698b-11e2-a6e3-02e81ae236e9&quot;</span><span class="p">,</span>
    <span class="s">&quot;type&quot;</span> <span class="p">:</span> <span class="s">&quot;user&quot;</span><span class="p">,</span>
    <span class="s">&quot;name&quot;</span> <span class="p">:</span> <span class="s">&quot;barney&quot;</span><span class="p">,</span>
    <span class="s">&quot;created&quot;</span> <span class="p">:</span> <span class="mi">1359405994314</span><span class="p">,</span>
    <span class="s">&quot;modified&quot;</span> <span class="p">:</span> <span class="mi">1361894320470</span><span class="p">,</span>
    <span class="s">&quot;activated&quot;</span> <span class="p">:</span> <span class="n">true</span><span class="p">,</span>
    <span class="s">&quot;email&quot;</span> <span class="p">:</span> <span class="s">&quot;barney@apigee.com&quot;</span><span class="p">,</span>
    <span class="s">&quot;metadata&quot;</span> <span class="p">:</span> <span class="p">{</span>
      <span class="s">&quot;path&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9&quot;</span><span class="p">,</span>
      <span class="s">&quot;sets&quot;</span> <span class="p">:</span> <span class="p">{</span>
        <span class="s">&quot;rolenames&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/rolenames&quot;</span><span class="p">,</span>
        <span class="s">&quot;permissions&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/permissions&quot;</span>
      <span class="p">},</span>
      <span class="s">&quot;collections&quot;</span> <span class="p">:</span> <span class="p">{</span>
        <span class="s">&quot;activities&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/activities&quot;</span><span class="p">,</span>
        <span class="s">&quot;devices&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/devices&quot;</span><span class="p">,</span>
        <span class="s">&quot;feed&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/feed&quot;</span><span class="p">,</span>
        <span class="s">&quot;groups&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/groups&quot;</span><span class="p">,</span>
        <span class="s">&quot;roles&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/roles&quot;</span><span class="p">,</span>
        <span class="s">&quot;following&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/following&quot;</span><span class="p">,</span>
        <span class="s">&quot;followers&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/d20976ff-802f-11e2-b690-02e81ae66238/users/cd789b00-698b-11e2-a6e3-02e81aeb26e9/followers&quot;</span>
      <span class="p">}</span>
    <span class="p">},</span>
    <span class="s">&quot;name&quot;</span> <span class="p">:</span> <span class="s">&quot;barney&quot;</span><span class="p">,</span>
    <span class="s">&quot;picture&quot;</span> <span class="p">:</span> <span class="s">&quot;http://www.gravatar.com/avatar/00767101f6b4f2cf5d02ed510dbcf0b4&quot;</span><span class="p">,</span>
    <span class="s">&quot;test&quot;</span> <span class="p">:</span> <span class="s">&quot;fred&quot;</span><span class="p">,</span>
    <span class="s">&quot;username&quot;</span> <span class="p">:</span> <span class="s">&quot;barney&quot;</span>
  <span class="p">}</span> <span class="p">],</span>
  <span class="s">&quot;timestamp&quot;</span> <span class="p">:</span> <span class="mi">1361903248398</span><span class="p">,</span>
  <span class="s">&quot;duration&quot;</span> <span class="p">:</span> <span class="mi">24</span><span class="p">,</span>
  <span class="s">&quot;organization&quot;</span> <span class="p">:</span> <span class="s">&quot;myorg&quot;</span><span class="p">,</span>
  <span class="s">&quot;applicationName&quot;</span> <span class="p">:</span> <span class="s">&quot;sandbox&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="deleting-a-group">
<h2>Deleting a group<a class="headerlink" href="#deleting-a-group" title="Permalink to this headline">¶</a></h2>
<p>To delete a group, delete the associated group entity as you would any
other entity. Note that this will only delete the group. Any entities in
the group will be preserved.</p>
<p>For more information and code samples, see <a class="reference external" href="../data-storage/entities.html#deleting-data-entities">Deleting Data
Entities</a>.</p>
</div>
<div class="section" id="adding-a-user-to-a-group">
<h2>Adding a user to a group<a class="headerlink" href="#adding-a-user-to-a-group" title="Permalink to this headline">¶</a></h2>
<p>You can add users to groups from client code using cURL commands or one
of the SDKs, as described here.</p>
<p>When setting up your application on the server, you might find it easier
and more convenient to create and populate groups with the admin portal.
There, you can create groups, create roles, and define permission rules
that govern user access to data and services in your application. For
more information, see <a class="reference external" href="../security-and-auth/app-security.html">Security &amp; Token
Authentication</a>.</p>
<p>Use the POST method to add a user to a group. If the named group does
not yet exist, an error message is returned.</p>
<div class="section" id="id6">
<h3>Request syntax<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>curl -X POST https://api.usergrid.com/&lt;org_id&gt;/&lt;app_id&gt;/groups/&lt;uuid | groupname&gt;/users/&lt;uuid | username&gt;
</pre></div>
</div>
</div>
<div class="section" id="id7">
<h3>Request URI<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>POST /&lt;org_id&gt;/&lt;app_id&gt;/groups/&lt;uuid | groupname&gt;/users/&lt;uuid | username&gt;
</pre></div>
</div>
<p>Parameters</p>
<table border="1" class="docutils">
<colgroup>
<col width="43%" />
<col width="57%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>arg uuid | string org_id</td>
<td>Organization UUID or organization name</td>
</tr>
<tr class="row-odd"><td>arg uuid | string app_id</td>
<td>Application UUID or application name</td>
</tr>
<tr class="row-even"><td>arg uuid | string groupname</td>
<td>UUID or name of the group</td>
</tr>
<tr class="row-odd"><td>arg uuid | string username</td>
<td>UUID or username of user</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id8">
<h3>Example<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
<p><strong>Note</strong>: Although not shown in the API examples below, you need to
provide a valid access token with each API call. See <a class="reference external" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating
users and application
clients</a>
for details.</p>
</div>
<div class="section" id="id9">
<h3>Request<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>curl -X POST &quot;https://api.usergrid.com/my-org/my-app/groups/mynewgroup/users/john.doe&quot;
</pre></div>
</div>
</div>
<div class="section" id="id10">
<h3>Response<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
    <span class="s">&quot;action&quot;</span><span class="p">:</span> <span class="s">&quot;post&quot;</span><span class="p">,</span>
    <span class="s">&quot;application&quot;</span><span class="p">:</span> <span class="s">&quot;7fb8d891-477d-11e1-b2bd-22000a1c4e22&quot;</span><span class="p">,</span>
    <span class="s">&quot;params&quot;</span><span class="p">:</span> <span class="p">{},</span>
    <span class="s">&quot;path&quot;</span><span class="p">:</span> <span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/users&quot;</span><span class="p">,</span>
    <span class="s">&quot;uri&quot;</span><span class="p">:</span> <span class="s">&quot;https://api.usergrid.com/22000a1c4e22-7fb8d891-477d-11e1-b2bd/7fb8d891-477d-11e1-b2bd-22000a1c4e22/groups/a668717b-67cb-11e1-8223-12313d14bde7/users&quot;</span><span class="p">,</span>
    <span class="s">&quot;entities&quot;</span><span class="p">:</span> <span class="p">[{</span>
        <span class="s">&quot;uuid&quot;</span><span class="p">:</span> <span class="s">&quot;6fbc8157-4786-11e1-b2bd-22000a1c4e22&quot;</span><span class="p">,</span>
        <span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;user&quot;</span><span class="p">,</span>
        <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;John Doe&quot;</span><span class="p">,</span>
        <span class="s">&quot;created&quot;</span><span class="p">:</span> <span class="mi">1327517852364015</span><span class="p">,</span>
        <span class="s">&quot;modified&quot;</span><span class="p">:</span> <span class="mi">1327517852364015</span><span class="p">,</span>
        <span class="s">&quot;activated&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
        <span class="s">&quot;email&quot;</span><span class="p">:</span> <span class="s">&quot;john.doe@mail.com&quot;</span><span class="p">,</span>
        <span class="s">&quot;metadata&quot;</span><span class="p">:</span> <span class="p">{</span>
            <span class="s">&quot;connecting&quot;</span><span class="p">:</span> <span class="p">{</span>
                <span class="s">&quot;owners&quot;</span><span class="p">:</span><span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/connecting/owners&quot;</span>
            <span class="p">},</span>
            <span class="s">&quot;path&quot;</span><span class="p">:</span> <span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22&quot;</span><span class="p">,</span>
            <span class="s">&quot;sets&quot;</span><span class="p">:</span> <span class="p">{</span>
                <span class="s">&quot;rolenames&quot;</span><span class="p">:</span> <span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/rolenames&quot;</span><span class="p">,</span>
                <span class="s">&quot;permissions&quot;</span><span class="p">:</span> <span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/permissions&quot;</span>
            <span class="p">},</span>
            <span class="s">&quot;collections&quot;</span><span class="p">:{</span>
                <span class="s">&quot;activities&quot;</span><span class="p">:</span><span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/activities&quot;</span><span class="p">,</span>
                <span class="s">&quot;devices&quot;</span><span class="p">:</span> <span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/devices&quot;</span><span class="p">,</span>
                <span class="s">&quot;feed&quot;</span><span class="p">:</span><span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/feed&quot;</span><span class="p">,</span>
                <span class="s">&quot;groups&quot;</span><span class="p">:</span> <span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/groups&quot;</span><span class="p">,</span>
                <span class="s">&quot;roles&quot;</span><span class="p">:</span><span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/roles&quot;</span><span class="p">,</span>
                <span class="s">&quot;following&quot;</span><span class="p">:</span> <span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/following&quot;</span><span class="p">,</span>
                <span class="s">&quot;followers&quot;</span><span class="p">:</span> <span class="s">&quot;/groups/a668717b-67cb-11e1-8223-12313d14bde7/users/6fbc8157-4786-11e1-b2bd-22000a1c4e22/followers&quot;</span>
            <span class="p">}</span>
        <span class="p">},</span>
        <span class="s">&quot;picture&quot;</span><span class="p">:</span> <span class="s">&quot;https://www.gravatar.com/avatar/90f823ba15655b8cc8e3b4d63377576f&quot;</span><span class="p">,</span>
        <span class="s">&quot;username&quot;</span><span class="p">:</span> <span class="s">&quot;john.doe&quot;</span>
    <span class="p">}],</span>
    <span class="s">&quot;timestamp&quot;</span><span class="p">:</span> <span class="mi">1331066031380</span><span class="p">,</span>
    <span class="s">&quot;duration&quot;</span><span class="p">:</span> <span class="mi">64</span><span class="p">,</span>
    <span class="s">&quot;organization&quot;</span> <span class="p">:</span> <span class="s">&quot;my-org&quot;</span><span class="p">,</span>
    <span class="s">&quot;applicationName&quot;</span><span class="p">:</span> <span class="s">&quot;my-app&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="removing-a-user-from-a-group">
<h2>Removing a user from a group<a class="headerlink" href="#removing-a-user-from-a-group" title="Permalink to this headline">¶</a></h2>
<p>Use the DELETE method to remove a user from the specified group.</p>
<div class="section" id="id11">
<h3>Request syntax<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>curl -X DELETE https://api.usergrid.com/&lt;org&gt;/&lt;app&gt;/groups/&lt;group&gt;/users/&lt;user&gt;&quot;
</pre></div>
</div>
<p>Parameters</p>
<table border="1" class="docutils">
<colgroup>
<col width="21%" />
<col width="79%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>org</td>
<td>Organization UUID or organization name</td>
</tr>
<tr class="row-odd"><td>app</td>
<td>Application UUID or application name</td>
</tr>
<tr class="row-even"><td>group</td>
<td>UUID or name of the group</td>
</tr>
<tr class="row-odd"><td>user</td>
<td>UUID, username or email of user to be deleted</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id12">
<h3>Example request<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre>curl -X DELETE https://api.usergrid.com/your-org/your-app/groups/someGroup/users/someUser
</pre></div>
</div>
</div>
<div class="section" id="id13">
<h3>Example response<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
  <span class="s">&quot;action&quot;</span> <span class="p">:</span> <span class="s">&quot;delete&quot;</span><span class="p">,</span>
  <span class="s">&quot;application&quot;</span> <span class="p">:</span> <span class="s">&quot;f34f4222-a166-11e2-a7f7-02e81adcf3d0&quot;</span><span class="p">,</span>
  <span class="s">&quot;params&quot;</span> <span class="p">:</span> <span class="p">{</span> <span class="p">},</span>
  <span class="s">&quot;path&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users&quot;</span><span class="p">,</span>
  <span class="s">&quot;uri&quot;</span> <span class="p">:</span> <span class="s">&quot;https://api.usergrid.com/your-org/your-app/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users&quot;</span><span class="p">,</span>
  <span class="s">&quot;entities&quot;</span> <span class="p">:</span> <span class="p">[</span> <span class="p">{</span>
    <span class="s">&quot;uuid&quot;</span> <span class="p">:</span> <span class="s">&quot;74d2d7da-e694-11e3-b0c6-4d2664c8e0c3&quot;</span><span class="p">,</span>
    <span class="s">&quot;type&quot;</span> <span class="p">:</span> <span class="s">&quot;user&quot;</span><span class="p">,</span>
    <span class="s">&quot;name&quot;</span> <span class="p">:</span> <span class="s">&quot;someUser&quot;</span><span class="p">,</span>
    <span class="s">&quot;created&quot;</span> <span class="p">:</span> <span class="mi">1401301104077</span><span class="p">,</span>
    <span class="s">&quot;modified&quot;</span> <span class="p">:</span> <span class="mi">1401301104077</span><span class="p">,</span>
    <span class="s">&quot;username&quot;</span> <span class="p">:</span> <span class="s">&quot;someUser&quot;</span><span class="p">,</span>
    <span class="s">&quot;email&quot;</span> <span class="p">:</span> <span class="s">&quot;your-org@apigee.com&quot;</span><span class="p">,</span>
    <span class="s">&quot;activated&quot;</span> <span class="p">:</span> <span class="n">true</span><span class="p">,</span>
    <span class="s">&quot;picture&quot;</span> <span class="p">:</span> <span class="s">&quot;http://www.gravatar.com/avatar/0455fc92de2636fc7a176cc5d298bb78&quot;</span><span class="p">,</span>
    <span class="s">&quot;metadata&quot;</span> <span class="p">:</span> <span class="p">{</span>
      <span class="s">&quot;path&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3&quot;</span><span class="p">,</span>
      <span class="s">&quot;sets&quot;</span> <span class="p">:</span> <span class="p">{</span>
        <span class="s">&quot;rolenames&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/roles&quot;</span><span class="p">,</span>
        <span class="s">&quot;permissions&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/permissions&quot;</span>
      <span class="p">},</span>
      <span class="s">&quot;collections&quot;</span> <span class="p">:</span> <span class="p">{</span>
        <span class="s">&quot;activities&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/activities&quot;</span><span class="p">,</span>
        <span class="s">&quot;devices&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/devices&quot;</span><span class="p">,</span>
        <span class="s">&quot;feed&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/feed&quot;</span><span class="p">,</span>
        <span class="s">&quot;groups&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/groups&quot;</span><span class="p">,</span>
        <span class="s">&quot;roles&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/roles&quot;</span><span class="p">,</span>
        <span class="s">&quot;following&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/following&quot;</span><span class="p">,</span>
        <span class="s">&quot;followers&quot;</span> <span class="p">:</span> <span class="s">&quot;/groups/cd796d0a-b90c-11e3-83de-83ceb9965c26/users/74d2d7da-e694-11e3-b0c6-4d2664c8e0c3/followers&quot;</span>
      <span class="p">}</span>
    <span class="p">}</span>
  <span class="p">}</span> <span class="p">],</span>
  <span class="s">&quot;timestamp&quot;</span> <span class="p">:</span> <span class="mi">1401751485776</span><span class="p">,</span>
  <span class="s">&quot;duration&quot;</span> <span class="p">:</span> <span class="mi">220</span><span class="p">,</span>
  <span class="s">&quot;organization&quot;</span> <span class="p">:</span> <span class="s">&quot;your-org&quot;</span><span class="p">,</span>
  <span class="s">&quot;applicationName&quot;</span> <span class="p">:</span> <span class="s">&quot;your-app&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="activity.html" class="btn btn-neutral float-right" title="Activity" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="working-user-data.html" class="btn btn-neutral" title="Working with User Data" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2013-2015, Apache Usergrid.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../',
            VERSION:'2.x',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </script>
      <script type="text/javascript" src="../_static/jquery.js"></script>
      <script type="text/javascript" src="../_static/underscore.js"></script>
      <script type="text/javascript" src="../_static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="../_static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>